/*-
 * Copyright (c) 2005 - 2011 CAS Dev Team
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the CAS Dev. Team nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      ASXMLRPCStub.hpp
 *
 * $CAS$
 */

#include "ASDebugHelper.hpp"
#include "ASLoadableObject.hpp"
#include "ASHandler.hpp"

using namespace CAS;

#define C_NO_ERROR               0
#define C_UNKNOWN_ERROR         -1
#define C_INTERNAL_SERVER_ERROR -2
#define C_SERVER_BUSY           -3
#define C_UNSUPPORTED_CALL      -4
#define C_FORBIDDEN             -5
#define C_INCORRECT_PARAMETER   -6
#define C_INCORRECT_VALUE       -7
#define C_INCORRECT_CALL_DATA   -8
#define C_NOT_SUPPORTED_YET     -9

namespace CAS_MOD
{

/**
  @class ASXMLRPCStub
  @brief Application server object
*/
class ASXMLRPCStub:
  public ASHandler
{
public:
	/**
	  @brief A constructor
	*/
	ASXMLRPCStub();

	/**
	  @brief A destructor
	*/
	~ASXMLRPCStub() throw();

private:
	/**
	  @brief Initialize handler
	  @param oData - data model
	  @param oRequest - request object
	  @param oResponse - response object
	  @param oGlobalPool - global pool of objects
	  @param oVhostPool - virtual host pool
	  @param oLocationConfig - location configuration
	  @param pContextData - context data
	  @param oIMC - Inter-Module communication object
	  @param oLogger - application server logger
	  @return HANDLER_OK - if success, HANDLER_ERROR - if any error occured, HANDLER_DONE - if no futher processing need
	*/
	INT_32 Handler(CTPP::CDT   & oData,
	               ASRequest   & oRequest,
	               ASResponse  & oResponse,
	               ASPool      & oGlobalPool,
	               ASPool      & oVhostPool,
	               ASPool      & oRequestPool,
	               CTPP::CDT   & oLocationConfig,
	               ASObject    * pContextData,
	               CTPP::CDT   & oIMC,
	               ASLogger    & oLogger);

	/**
	  @brief Report XML RPC error
	*/
	void ReportError(const INT_32          iError,
	                 const STLW::string  & sErrorDescr,
	                 const STLW::string  & sRemoteIP,
	                 CTPP::CDT           & oResult);

	/**
	  @brief Get handler name
	*/
	CCHAR_P GetObjectName() const;
};

EXPORT_HANDLER(ASXMLRPCStub)

//
// A constructor
//
ASXMLRPCStub::ASXMLRPCStub()
{
	;;
}

//
// Initialize handler
//
INT_32 ASXMLRPCStub::Handler(CTPP::CDT   & oData,
                             ASRequest   & oRequest,
                             ASResponse  & oResponse,
                             ASPool      & oGlobalPool,
                             ASPool      & oVhostPool,
                             ASPool      & oRequestPool,
                             CTPP::CDT   & oLocationConfig,
                             ASObject    * pContextData,
                             CTPP::CDT   & oIMC,
                             ASLogger    & oLogger)
{
	using namespace CTPP;

	DEBUG_HELPER(&oLogger, "ASXMLRPCStub::Handler");

	// 200 OK
	oResponse.SetHTTPCode(200);
	// Set HTTP header
	oResponse.SetHeader("X-Module", "ASXMLRPCStub");

	// Get method
	const STLW::string  sMethod = oRequest.arguments.GetCDT("method").GetString();
	if (sMethod.empty())
	{
		oLogger.Warn("ASXMLRPCStub: Missed XML RPC method name!");
		return HANDLER_ERROR;
	}

	// Get remote IP
	STLW::string sRemoteIP = oRequest.headers.GetCDT("X-Real-IP").GetString();
	if (sRemoteIP.empty())
	{
		sRemoteIP = oRequest.headers.GetCDT("X-Forwarded-For").GetString();
		if (sRemoteIP.empty())
		{
			sRemoteIP = oRequest.remote_ip;
		}
	}

	// Get list of methods
	if (sMethod == "XMLRPC::get_methods_list")
	{
		CDT oMethods = oIMC.GetCDT("rpc").GetCDT("methods");
		if (oMethods.GetType() != CDT::ARRAY_VAL)
		{
			oLogger.Warn("No methods in list");
			oMethods = CDT(CDT::ARRAY_VAL);
		}

		oMethods.PushBack("XMLRPC::get_methods_list");

		oData["status"]  = "OK";
		oData["methods"] = oMethods;
	}
	else
	{
		ReportError(C_NOT_SUPPORTED_YET, STLW::string("RPC Call `") + sMethod + "` not supported yet.", sRemoteIP, oData);
	}

return HANDLER_DONE;
}

//
// Print<F10> error code
//
void ASXMLRPCStub::ReportError(const INT_32          iError,
                               const STLW::string  & sErrorDescr,
                               const STLW::string  & sRemoteIP,
                               CTPP::CDT           & oResult)
{
	using namespace CTPP;
	oResult = CDT(CDT::HASH_VAL);

	oResult["status"] = "ERROR";
	oResult["error"]["errno"]    = iError;
	oResult["error"]["strerror"] = sErrorDescr;

	oResult["client"]["remote_ip"] = sRemoteIP;
}

//
// Get handler name
//
CCHAR_P ASXMLRPCStub::GetObjectName() const { return "ASXMLRPCStub"; }

//
// A destructor
//
ASXMLRPCStub::~ASXMLRPCStub() throw()
{
	;;
}

} // namespace CAS_MOD
// End.

